Procurement APIs
Resource for creating new imported supplier invoice
HTTP method | POST |
URI | https://api.rambase.net/procurement/imported-invoices |
Supported formats | Xml, Html, Json (ex. $format=json) |
Custom fields | Custom fields supported |
Successful HTTP status code | 201 |
API resource identifier | 2818, version 17 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
ImportedSupplierInvoice
This field is optional.
>ExternalReference
Unique identifier of the file. Used to make sure that the same file is not procesed more than once.
This field is optional.
>{String}</ExternalReference>RegistrationDate
The issue date to the invoice
This field is optional.
>{Date}</RegistrationDate>SuppliersReference
The reference to the imported supplier invoice
This field is optional.
>{String}</SuppliersReference>SuppliersReferenceNumber
Supplier invoice number generated by the supplier invoicing system
This field is optional.
>{String}</SuppliersReferenceNumber>Currency
The currency to the imported supplier invoice
This field is optional.
>{String}</Currency>IsCreditNote
Is the imported invoice from type credit note
Default value: False
This field is optional.
>{Boolean}</IsCreditNote>BuyersContact
This field is optional.
>Name
Name of the RamBase contact (legal entity or person)
This field is optional.
>{String}</Name>Phone
Phone number of the RamBase contact
This field is optional.
>{String}</Phone>E-mail of the RamBase contact
This field is optional.
>{String}</Email>VATAccounting
This field is optional.
>Currency
The currency used for VAT to the imported supplier invoice
This field is optional.
>{String}</Currency>Date
The date when the VAT becomes accountable
This field is optional.
>{Date}</Date>VATAmount
Total amount of VAT in VAT currency on the invoice
This field is optional.
>{Decimal}</VATAmount>VATRegistrationNumber
VAT registration number of the company which should be used for the invoice or credit.
This field is optional.
>{String}</VATRegistrationNumber>Totals
This field is optional.
>FreightAmount
Freight of the invoice
This field is optional.
>{Decimal}</FreightAmount>FeeAmount
Fee of the invoice
This field is optional.
>{Decimal}</FeeAmount>SubTotalAmount
Total net amount on the invoice
This field is optional.
>{Decimal}</SubTotalAmount>VATAmount
Total amount of VAT on the invoice
This field is optional.
>{Decimal}</VATAmount>TotalAmount
Total net amount on the invoice
This field is optional.
>{Decimal}</TotalAmount>RoundOffAmount
The round off to the imported supplier invoice
This field is optional.
>{Decimal}</RoundOffAmount>Payment
This field is optional.
>DueDate
The due date of the imported supplier invoice
This field is optional.
>{Date}</DueDate>AccountName
The bank account name to the payment receiver
This field is optional.
>{String}</AccountName>AccountNumber
The bank account number to the payment receiver
This field is optional.
>{String}</AccountNumber>IBAN
The international bank account number (IBAN) to the payment receiver
This field is optional.
>{String}</IBAN>SWIFTCode
The bank identification code (BIC) to the account to the payment receiver
This field is optional.
>{String}</SWIFTCode>SuppliersReference
The reference to the payment receiver
This field is optional.
>{String}</SuppliersReference>Supplier
This field is optional.
>Name
The name of the supplier
This field is optional.
>{String}</Name>LegalEntityIdentifier
The enterprise number to the supplier
This field is optional.
>{String}</LegalEntityIdentifier>InvoiceAddress
This field is optional.
>Attention
The attention to the supplier
This field is optional.
>{String}</Attention>AddressLine1
The street name to the supplier
This field is optional.
>{String}</AddressLine1>AddressLine2
The additional street name to the supplier
This field is optional.
>{String}</AddressLine2>Region
The state to the supplier
This field is optional.
>{String}</Region>PostalCode
The postal code to the supplier
This field is optional.
>{String}</PostalCode>City
The city to the supplier
This field is optional.
>{String}</City>CountryCode
The country code to the supplier
This field is optional.
>{String}</CountryCode>Contact
This field is optional.
>Name
Name of the suppliers contact (legal entity or person)
This field is optional.
>{String}</Name>Phone
Phone number of the suppliers contact
This field is optional.
>{String}</Phone>E-mail of the suppliers contact
This field is optional.
>{String}</Email>ShippedFrom
This field is optional.
>AddressLine1
The street name to the shipped from address
This field is optional.
>{String}</AddressLine1>AddressLine2
The additional street name to the shipped from address
This field is optional.
>{String}</AddressLine2>PostalCode
The postal code to the shipped from address
This field is optional.
>{String}</PostalCode>City
The city to the shipped from address
This field is optional.
>{String}</City>Region
The state to the shipped from address
This field is optional.
>{String}</Region>CountryCode
The country code to the shipped from address
This field is optional.
>{String}</CountryCode>ShippedTo
This field is optional.
>AddressLine1
The street name of the shipped to address
This field is optional.
>{String}</AddressLine1>AddressLine2
The additional street name of the shipped to address
This field is optional.
>{String}</AddressLine2>PostalCode
The postal code to the shipped to address
This field is optional.
>{String}</PostalCode>City
The city to the shipped to address
This field is optional.
>{String}</City>Region
The state of the shipped to address
This field is optional.
>{String}</Region>CountryCode
The country code to the shipped to address
This field is optional.
>{String}</CountryCode>ImportedSupplierInvoice
This field is optional.
": {ExternalReference
Unique identifier of the file. Used to make sure that the same file is not procesed more than once.
This field is optional.
": "{String}",RegistrationDate
The issue date to the invoice
This field is optional.
": "{Date}",SuppliersReference
The reference to the imported supplier invoice
This field is optional.
": "{String}",SuppliersReferenceNumber
Supplier invoice number generated by the supplier invoicing system
This field is optional.
": "{String}",Currency
The currency to the imported supplier invoice
This field is optional.
": "{String}",IsCreditNote
Is the imported invoice from type credit note
Default value: False
This field is optional.
": "{Boolean}",BuyersContact
This field is optional.
": {Name
Name of the RamBase contact (legal entity or person)
This field is optional.
": "{String}",Phone
Phone number of the RamBase contact
This field is optional.
": "{String}",E-mail of the RamBase contact
This field is optional.
": "{String}"VATAccounting
This field is optional.
": {Currency
The currency used for VAT to the imported supplier invoice
This field is optional.
": "{String}",Date
The date when the VAT becomes accountable
This field is optional.
": "{Date}",VATAmount
Total amount of VAT in VAT currency on the invoice
This field is optional.
": "{Decimal}",VATRegistrationNumber
VAT registration number of the company which should be used for the invoice or credit.
This field is optional.
": "{String}"Totals
This field is optional.
": {FreightAmount
Freight of the invoice
This field is optional.
": "{Decimal}",FeeAmount
Fee of the invoice
This field is optional.
": "{Decimal}",SubTotalAmount
Total net amount on the invoice
This field is optional.
": "{Decimal}",VATAmount
Total amount of VAT on the invoice
This field is optional.
": "{Decimal}",TotalAmount
Total net amount on the invoice
This field is optional.
": "{Decimal}",RoundOffAmount
The round off to the imported supplier invoice
This field is optional.
": "{Decimal}"Payment
This field is optional.
": {DueDate
The due date of the imported supplier invoice
This field is optional.
": "{Date}",AccountName
The bank account name to the payment receiver
This field is optional.
": "{String}",AccountNumber
The bank account number to the payment receiver
This field is optional.
": "{String}",IBAN
The international bank account number (IBAN) to the payment receiver
This field is optional.
": "{String}",SWIFTCode
The bank identification code (BIC) to the account to the payment receiver
This field is optional.
": "{String}",SuppliersReference
The reference to the payment receiver
This field is optional.
": "{String}"Supplier
This field is optional.
": {Name
The name of the supplier
This field is optional.
": "{String}",LegalEntityIdentifier
The enterprise number to the supplier
This field is optional.
": "{String}",InvoiceAddress
This field is optional.
": {Attention
The attention to the supplier
This field is optional.
": "{String}",AddressLine1
The street name to the supplier
This field is optional.
": "{String}",AddressLine2
The additional street name to the supplier
This field is optional.
": "{String}",Region
The state to the supplier
This field is optional.
": "{String}",PostalCode
The postal code to the supplier
This field is optional.
": "{String}",City
The city to the supplier
This field is optional.
": "{String}",CountryCode
The country code to the supplier
This field is optional.
": "{String}"Contact
This field is optional.
": {Name
Name of the suppliers contact (legal entity or person)
This field is optional.
": "{String}",Phone
Phone number of the suppliers contact
This field is optional.
": "{String}",E-mail of the suppliers contact
This field is optional.
": "{String}"ShippedFrom
This field is optional.
": {AddressLine1
The street name to the shipped from address
This field is optional.
": "{String}",AddressLine2
The additional street name to the shipped from address
This field is optional.
": "{String}",PostalCode
The postal code to the shipped from address
This field is optional.
": "{String}",City
The city to the shipped from address
This field is optional.
": "{String}",Region
The state to the shipped from address
This field is optional.
": "{String}",CountryCode
The country code to the shipped from address
This field is optional.
": "{String}"ShippedTo
This field is optional.
": {AddressLine1
The street name of the shipped to address
This field is optional.
": "{String}",AddressLine2
The additional street name of the shipped to address
This field is optional.
": "{String}",PostalCode
The postal code to the shipped to address
This field is optional.
": "{String}",City
The city to the shipped to address
This field is optional.
": "{String}",Region
The state of the shipped to address
This field is optional.
": "{String}",CountryCode
The country code to the shipped to address
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
$showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ImportedSupplierInvoiceId
Imported supplier invoice identifier
>{Integer}</ImportedSupplierInvoiceId>Status
Status of imported supplier invoice
Possible domain values can be found here
>{Integer}</Status>ImportedAt
The date and time when the file was imported
>{Datetime}</ImportedAt>ExternalReference
Unique identifier of the file. Used to make sure that the same file is not procesed more than once.
>{String}</ExternalReference>RegistrationDate
The issue date to the invoice
>{Date}</RegistrationDate>SuppliersReference
The reference to the imported supplier invoice
>{String}</SuppliersReference>SuppliersReferenceNumber
Supplier invoice number generated by the supplier invoicing system
>{String}</SuppliersReferenceNumber>Currency
The currency to the imported supplier invoice
>{String}</Currency>IsCreditNote
Is the imported invoice from type credit note
>{Boolean}</IsCreditNote>ImportedBy
The PID to the user that imported the file
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>ImportedFile
Refers to the file document where the file are stored
>FileVersionId
File identifier
>{Integer}</FileVersionId>FileVersionLink
File reference
>{String}</FileVersionLink>Name
Name of the RamBase contact (legal entity or person)
>{String}</Name>Phone
Phone number of the RamBase contact
>{String}</Phone>E-mail of the RamBase contact
>{String}</Email>Currency
The currency used for VAT to the imported supplier invoice
>{String}</Currency>Date
The date when the VAT becomes accountable
>{Date}</Date>VATAmount
Total amount of VAT in VAT currency on the invoice
>{Decimal}</VATAmount>VATRegistrationNumber
VAT registration number of the company which should be used for the invoice or credit.
>{String}</VATRegistrationNumber>Currency
The currency to the imported supplier invoice
>{String}</Currency>FreightAmount
Freight of the invoice
>{Decimal}</FreightAmount>FeeAmount
Fee of the invoice
>{Decimal}</FeeAmount>SubTotalAmount
Total net amount on the invoice
>{Decimal}</SubTotalAmount>VATAmount
Total amount of VAT on the invoice
>{Decimal}</VATAmount>TotalAmount
Total net amount on the invoice
>{Decimal}</TotalAmount>RoundOffAmount
The round off to the imported supplier invoice
>{Decimal}</RoundOffAmount>DueDate
The due date of the imported supplier invoice
>{Date}</DueDate>AccountName
The bank account name to the payment receiver
>{String}</AccountName>AccountNumber
The bank account number to the payment receiver
>{String}</AccountNumber>IBAN
The international bank account number (IBAN) to the payment receiver
>{String}</IBAN>SWIFTCode
The bank identification code (BIC) to the account to the payment receiver
>{String}</SWIFTCode>SuppliersReference
The reference to the payment receiver
>{String}</SuppliersReference>Name
The name of the supplier
>{String}</Name>LegalEntityIdentifier
The enterprise number to the supplier
>{String}</LegalEntityIdentifier>Attention
The attention to the supplier
>{String}</Attention>AddressLine1
The street name to the supplier
>{String}</AddressLine1>AddressLine2
The additional street name to the supplier
>{String}</AddressLine2>Region
The state to the supplier
>{String}</Region>PostalCode
The postal code to the supplier
>{String}</PostalCode>City
The city to the supplier
>{String}</City>CountryCode
The country code to the supplier
>{String}</CountryCode>Country
Name of country
>{String}</Country>SupplierReference
The account to the supplier
>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>FirstName
Firstname/givenname if the supplier is a person
>{String}</FirstName>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>SupplierLink
Supplier reference
>{String}</SupplierLink>Name
Name of the suppliers contact (legal entity or person)
>{String}</Name>Phone
Phone number of the suppliers contact
>{String}</Phone>E-mail of the suppliers contact
>{String}</Email>AddressLine1
The street name to the shipped from address
>{String}</AddressLine1>AddressLine2
The additional street name to the shipped from address
>{String}</AddressLine2>PostalCode
The postal code to the shipped from address
>{String}</PostalCode>City
The city to the shipped from address
>{String}</City>Region
The state to the shipped from address
>{String}</Region>CountryCode
The country code to the shipped from address
>{String}</CountryCode>Country
Name of country
>{String}</Country>AddressReferences
The identifier to the shipped from address
>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</FirstName>AddressLink
Supplier address reference
>{String}</AddressLink>AddressLine1
The street name of the shipped to address
>{String}</AddressLine1>AddressLine2
The additional street name of the shipped to address
>{String}</AddressLine2>PostalCode
The postal code to the shipped to address
>{String}</PostalCode>City
The city to the shipped to address
>{String}</City>Region
The state of the shipped to address
>{String}</Region>CountryCode
The country code to the shipped to address
>{String}</CountryCode>Country
Name of country
>{String}</Country>AddressReference
Reference to the shipped to address. Can be a reference to location address, customer address or supplier address
>Description
Description of address reference, Ex. if reference is to a location, this description will be the name of the location.
>{String}</Description>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>BacklogObject
Reference to a backlog object in RamBase based on information on the received supplier invoice.
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>Assignee
The user who has been assigned to work with this object.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>ImportedSupplierInvoiceId
Imported supplier invoice identifier
": "{Integer}",Status
Status of imported supplier invoice
Possible domain values can be found here
": "{Integer}",ImportedAt
The date and time when the file was imported
": "{Datetime}",ExternalReference
Unique identifier of the file. Used to make sure that the same file is not procesed more than once.
": "{String}",RegistrationDate
The issue date to the invoice
": "{Date}",SuppliersReference
The reference to the imported supplier invoice
": "{String}",SuppliersReferenceNumber
Supplier invoice number generated by the supplier invoicing system
": "{String}",Currency
The currency to the imported supplier invoice
": "{String}",IsCreditNote
Is the imported invoice from type credit note
": "{Boolean}",ImportedBy
The PID to the user that imported the file
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"ImportedFile
Refers to the file document where the file are stored
": {FileVersionId
File identifier
": "{Integer}",FileVersionLink
File reference
": "{String}"Name
Name of the RamBase contact (legal entity or person)
": "{String}",Phone
Phone number of the RamBase contact
": "{String}",E-mail of the RamBase contact
": "{String}"Currency
The currency used for VAT to the imported supplier invoice
": "{String}",Date
The date when the VAT becomes accountable
": "{Date}",VATAmount
Total amount of VAT in VAT currency on the invoice
": "{Decimal}",VATRegistrationNumber
VAT registration number of the company which should be used for the invoice or credit.
": "{String}"Currency
The currency to the imported supplier invoice
": "{String}",FreightAmount
Freight of the invoice
": "{Decimal}",FeeAmount
Fee of the invoice
": "{Decimal}",SubTotalAmount
Total net amount on the invoice
": "{Decimal}",VATAmount
Total amount of VAT on the invoice
": "{Decimal}",TotalAmount
Total net amount on the invoice
": "{Decimal}",RoundOffAmount
The round off to the imported supplier invoice
": "{Decimal}"DueDate
The due date of the imported supplier invoice
": "{Date}",AccountName
The bank account name to the payment receiver
": "{String}",AccountNumber
The bank account number to the payment receiver
": "{String}",IBAN
The international bank account number (IBAN) to the payment receiver
": "{String}",SWIFTCode
The bank identification code (BIC) to the account to the payment receiver
": "{String}",SuppliersReference
The reference to the payment receiver
": "{String}"Name
The name of the supplier
": "{String}",LegalEntityIdentifier
The enterprise number to the supplier
": "{String}",Attention
The attention to the supplier
": "{String}",AddressLine1
The street name to the supplier
": "{String}",AddressLine2
The additional street name to the supplier
": "{String}",Region
The state to the supplier
": "{String}",PostalCode
The postal code to the supplier
": "{String}",City
The city to the supplier
": "{String}",CountryCode
The country code to the supplier
": "{String}",Country
Name of country
": "{String}"SupplierReference
The account to the supplier
": {SupplierId
RamBase supplier identifier
": "{Integer}",FirstName
Firstname/givenname if the supplier is a person
": "{String}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",SupplierLink
Supplier reference
": "{String}"Name
Name of the suppliers contact (legal entity or person)
": "{String}",Phone
Phone number of the suppliers contact
": "{String}",E-mail of the suppliers contact
": "{String}"AddressLine1
The street name to the shipped from address
": "{String}",AddressLine2
The additional street name to the shipped from address
": "{String}",PostalCode
The postal code to the shipped from address
": "{String}",City
The city to the shipped from address
": "{String}",Region
The state to the shipped from address
": "{String}",CountryCode
The country code to the shipped from address
": "{String}",Country
Name of country
": "{String}",AddressReferences
The identifier to the shipped from address
": {AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",FirstName
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLink
Supplier address reference
": "{String}"AddressLine1
The street name of the shipped to address
": "{String}",AddressLine2
The additional street name of the shipped to address
": "{String}",PostalCode
The postal code to the shipped to address
": "{String}",City
The city to the shipped to address
": "{String}",Region
The state of the shipped to address
": "{String}",CountryCode
The country code to the shipped to address
": "{String}",Country
Name of country
": "{String}",AddressReference
Reference to the shipped to address. Can be a reference to location address, customer address or supplier address
": {Description
Description of address reference, Ex. if reference is to a location, this description will be the name of the location.
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}"BacklogObject
Reference to a backlog object in RamBase based on information on the received supplier invoice.
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 101079 HTTP 400 | Mismatch in size of revision parameters |